home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / disk / misc / filex11.lha / FileX / Docs / English / FileXARexx.doc < prev    next >
Encoding:
Text File  |  1993-10-22  |  29.6 KB  |  1,568 lines
  1.                                    
  2.              $VER: FileXARexxDocumentation 1.1 (16.10.93)
  3.  
  4.                                    
  5.                      FileX - A binary file editor
  6.  
  7.                    Copyright 1993 by Klaas Hermanns
  8.  
  9.                     Shareware, all rights reserved.
  10.  
  11. In general
  12. **********
  13.  
  14.    FileX has an arexxport which is quite completely based on the
  15. Commodore Amiga User Interface Style Guide.
  16.  
  17.    If there is nothing different specified for the PORTNAME at the
  18. beginning, the port will be named `FILEX'. In case that this portname
  19. does already exist, a number is being added to the name and increased
  20. until a not already used name is found. (`NAME'->`NAME.1'->`NAME.2')
  21.  
  22.    The arguments will be evaluated in the way AmigaDOS does. If the
  23. different argument types are unknown, the following list can be used as
  24. a reference.
  25.  
  26. <arg>
  27.      A simple string. It's not necessary to specify the argument's name.
  28.  
  29. <arg>/S
  30.      Switch. Will be set through declaring an argument.
  31.  
  32. <arg>/K
  33.      Key word.  This argument must be given with an argument's name.
  34.      (`<arg> = value' oder `<arg> value'.
  35.  
  36. <arg>/N
  37.      Number.  This argument must be a decimal number.
  38.  
  39. <arg>/T
  40.      Changing switch.  Through specification of this argument a value
  41.      will change its condition.
  42.  
  43. <arg>/A
  44.      This argument must be given.
  45.  
  46. <arg>/F
  47.      The rest of the line will be understood as an argument, although if
  48.      there are some more keywords
  49.  
  50. <arg>/M
  51.      Serveral values are possible.
  52.  
  53.    For all commands that return something it's possible to set a
  54. variable to the return value by specifing the name of it with the
  55. argument VAR.  The same applies to the argument STEM and its
  56. stemvariables.
  57.  
  58. Command overview (alphabetical order)
  59. *************************************
  60.  
  61.      Name:           Arguments => return values:
  62.      -------------------------------------------
  63.      ACTIVATE
  64.      ACTIVATEWINDOW
  65.      APPEND
  66.      ASSIGNCOMMAND   NUMBER/N/K,NAME/K
  67.      CHANGEWINDOW    LEFTEDGE/N/K,TOPEDGE/N/K,HEIGHT/N/K,WIDTH/N/K
  68.      CLEAR           FORCE/S
  69.      COLUMN          DELTA/N/A
  70.      COPY
  71.      CURSOR          UP/S,DOWN/S,LEFT/S,RIGHT/S
  72.      CUT
  73.      DEACTIVATE
  74.      EXECUTECOMMAND  NUMBER/N/K,NAME/K
  75.      FAULT           VAR/K,STEM/K,NUMBER/N/A => DESCRIPTION
  76.      FILL
  77.      FIND            PROMPT/S,HEX/S,BACKWARDS/S,QUIET/S,TEXT/F
  78.      FINDCHANGE      PROMPT/S,HEX/S,ALL/S,BACKWARDS/S,QUIET/S,FIND,CHANGE
  79.      FINDNEXT        BACKWARDS/S,QUIET/S
  80.      FONT            NAME/A,SIZE/A/N
  81.      GETATTR         OBJECT/A,FIELD,STEM/K,VAR/K
  82.      GETBLOCK        VAR/K,STEM/K => BLOCK
  83.      GETBYTES        VAR/K,STEM/K,POS/N/A,NUMBER/N/A => HEXSTRING
  84.      GOTOBOOKMARK    NUMBER/N
  85.      GOTOBYTE        POS/N/A
  86.      GOTOCOLUMN      COLUMN/N/A
  87.      GOTOLINE        LINE/N/A
  88.      GRABMEMORY      START/A/N,END/A/N,FORCE/S
  89.      HELP            VAR/K,STEM/K,COMMAND => COMMANDDESC,COMMANDLIST/M
  90.      INSERT
  91.      LINE            DELTA/N/A
  92.      LOADBLOCK       NAME
  93.      LOADBLOCKCLIP
  94.      LOADCOMMANDS    NAME
  95.      LOADDISPLAYTYP  NAME
  96.      LOADSETTINGS    NAME
  97.      MOVEWINDOW      LEFTEDGE/N,TOPEDGE/N
  98.      NOP
  99.      OPEN            FILENAME,FORCE/S
  100.      PASTE
  101.      POSITION        SOF/S,EOF/S,SOL/S,EOL/S
  102.      PRINT
  103.      PRINTBLOCK
  104.      QUIT            FORCE/S
  105.      REDO            NUMBER/N
  106.      REQUESTFILE     VAR/K,STEM/K,TITLE/K,PATH/K,FILE/K,PATTERN/K => FILENAME
  107.      REQUESTNOTIFY   PROMPT
  108.      REQUESTRESPONSE BUTTONS/K,PROMPT/K
  109.      REQUESTSTRING   VAR/K,STEM/K,PROMPT/K,DEFAULT/K => STRING
  110.      RX              VAR/K,STEM/K,CONSOLE/S,ASYNC/S,COMMAND/F => RC/N,RESULT
  111.      SAVE
  112.      SAVEAS          NAME
  113.      SAVEBLOCK       NAME
  114.      SAVEBLOCKCLIP
  115.      SAVECOMMANDS
  116.      SAVECOMMANDSAS  NAME
  117.      SAVESETTINGS
  118.      SAVESETTINGSAS  NAME
  119.      SETATTR         OBJECT/A,FIELD,FROMSTEM/K,FROMVAR/K
  120.      SETBLOCK        BLOCK/A
  121.      SETBLOCKMARK
  122.      SETBOOKMARK     NUMBER/N
  123.      SETBYTES        POS/N/A,HEXSTRING/A
  124.      SETSCREEN       NAME/K,OWN/S
  125.      SIZEWINDOW      HEIGHT/N,WIDTH/N
  126.      UNDO            NUMBER/N
  127.      WINDOWTOBACK
  128.      WINDOWTOFRONT
  129.      ZIPWINDOW
  130.  
  131. Command descriptions
  132. ********************
  133.  
  134. ACTIVATE
  135. ========
  136.  
  137. Synopsis:
  138.      ACTIVATE
  139.  
  140. Function:
  141.      Reactivates FileX from iconify mode.
  142.  
  143. Example:
  144.           DEACTIVATE      /* Equivalent to menu: `Project/Iconify' */
  145.           
  146.           /* Now an icon will appear on the workbench. FileX `sleeps'. */
  147.           
  148.           ACTIVATE        /* The window will be opened again */
  149.  
  150. See also:
  151.      DEACTIVATE
  152.  
  153. ACTIVATEWINDOW
  154. ==============
  155.  
  156. Synopsis:
  157.      ACTIVATEWINDOW
  158.  
  159. Function:
  160.      Activates the FileX window.
  161.  
  162. APPEND
  163. ======
  164.  
  165. Synopsis:
  166.      APPEND
  167.  
  168. Function:
  169.      The current Block will be appended to the file end.
  170.  
  171. See also:
  172.      Menu: `Edit/Append'
  173.  
  174. ASSIGNCOMMAND
  175. =============
  176.  
  177. Synopsis:
  178.      ASSIGNCOMMAND NUMBER/N/K,NAME/K
  179.  
  180. Function:
  181.      Sets one of the arexxcommands in the `ARexx'-menu.
  182.  
  183. Arguments:
  184.     NUMBER/N/K:
  185.           A number between 0 and 10 which defines the command's
  186.           position.  A requester will appear if no number had been
  187.           specified.
  188.  
  189.     NAME/K:
  190.           The command's filename.  Here, a requester to choose the
  191.           filename will appear, too, if no name had been specified
  192.           previously.
  193.  
  194. Example:
  195.      ASSIGNCOMMAND 0 'dh0:MyArexxCommands/FileXcommand'.
  196.  
  197. See also:
  198.      Menu: `ARexx/Assign command', LOADCOMMANDS, SAVECOMMANDS,
  199.      SAVECOMMANDSAS
  200.  
  201. CHANGEWINDOW
  202. ============
  203.  
  204. Synopsis:
  205.      CHANGEWINDOW LEFTEDGE/N/K,TOPEDGE/N/K,HEIGHT/N/K,WIDTH/N/K
  206.  
  207. Function:
  208.      Modifies the size and/or the location of the FileX window.
  209.  
  210. Arguments:
  211.     LEFTEDGE/N:
  212.           New left offset of the window to the left border.
  213.  
  214.     TOPEDGE/N:
  215.           New upper offset of the window to the upper boder.
  216.  
  217.     HEIGHT/N:
  218.           New height of the window.
  219.  
  220.     WIDTH/N:
  221.           New width of the window.
  222.  
  223.      If no new value is specified, the old value remains unchanged.
  224.  
  225. Example:
  226.              /* Resize window to maximum height */
  227.           CHANGEWINDOW LEFTEDGE 0 TOPEDGE 0 HEIGHT 900
  228.  
  229. See also:
  230.      ZIPWINDOW, MOVEWINDOW, SIZEWINDOW, Attributs:  `WINDOW/#?'
  231.  
  232. CLEAR
  233. =====
  234.  
  235. Synopsis:
  236.      CLEAR FORCE/S
  237.  
  238. Function:
  239.      Removes the current file from memory.
  240.  
  241. Arguments:
  242.     FORCE/S:
  243.           The requester `You made x changes' will be suppressed.
  244.  
  245. Returncodes:
  246.      Return code = 5, if the file could not be removed.
  247.  
  248. See also:
  249.      Menu: `Project/New'
  250.  
  251. COLUMN
  252. ======
  253.  
  254. Synopsis:
  255.      COLUMN DELTA/N/A
  256.  
  257. Function:
  258.      Moves the cursor to the left or the right.
  259.  
  260. Arguments:
  261.     DELTA/N/A:
  262.           Number of moves the cursor shall do. Positive values will
  263.           move the cursor to the right and negative ones move it to the
  264.           left.
  265.  
  266. See also:
  267.      GOTOBYTE, GOTOCOLUMN, GOTOLINE, LINE
  268.  
  269. COPY
  270. ====
  271.  
  272. Synopsis:
  273.      COPY
  274.  
  275. Function:
  276.      Copies the current marked block to the blockbuffer.
  277.  
  278. See also:
  279.      Menu: `Edit/Copy', SETBLOCKMARK
  280.  
  281. CURSOR
  282. ======
  283.  
  284. Synopsis:
  285.      CURSOR          UP/S,DOWN/S,LEFT/S,RIGHT/S
  286.  
  287. Function:
  288.      Moves the cursor.
  289.  
  290. Arguments:
  291.     UP/S:
  292.           The cursor will be moved one line up.
  293.  
  294.     DOWN/S:
  295.           The cursor will be moved one line down.
  296.  
  297.     LEFT/S:
  298.           The cursor will be moved one column left.
  299.  
  300.     RIGHT/S:
  301.           The cursor will be moved one column right.
  302.  
  303.      UP and DOWN as well as LEFT and RIGHT exclude each other.
  304.  
  305. See also:
  306.      GOTOBYTE, LINE, COLUMN
  307.  
  308. CUT
  309. ===
  310.  
  311. Synopsis:
  312.      CUT
  313.  
  314. Function:
  315.      Copies the current marked block to the blockbuffer and cuts it
  316.      from the file simultaneously.
  317.  
  318. See also:
  319.      Menu: `Edit/Cut', SETBLOCKMARK
  320.  
  321. DEACTIVATE
  322. ==========
  323.  
  324. Synopsis:
  325.      DEACTIVATE
  326.  
  327. Function:
  328.      Iconifies FileX. The window will be closed and an icon produced on
  329.      the workbench.
  330.  
  331. See also:
  332.      ACTIVATE
  333.  
  334. EXECUTECOMMAND
  335. ==============
  336.  
  337. Synopsis:
  338.      EXECUTECOMMAND  NUMBER/N/K,NAME/K
  339.  
  340. Function:
  341.      Executes an arexxscript.
  342.  
  343. Arguments:
  344.     NUMBER/N/K:
  345.           A number between 0 and 9 of a command installed by
  346.           ASSIGNCOMMAND.
  347.  
  348.     NAME/K:
  349.           Name of an arexxscript.
  350.  
  351.      Both arguments exclude each other.
  352.  
  353. See also:
  354.      ASSIGNCOMMAND
  355.  
  356. FAULT
  357. =====
  358.  
  359. Synopsis:
  360.      FAULT VAR/K,STEM/K,NUMBER/N/A => DESCRIPTION
  361.  
  362. Function:
  363.      Finds out the faulty text belonging to a dos error number.
  364.  
  365. Arguments:
  366.     NUMBER/N/A:
  367.           Dos error number.
  368.  
  369. Returncodes:
  370.     DESCRIPTION:
  371.           The belonging text.
  372.  
  373. Example:
  374.           FAULT 114
  375.           
  376.           /* Result value using localized workbench: */
  377.           /* `: Wrong name-pattern' */
  378.  
  379. FILL
  380. ====
  381.  
  382. Synopsis:
  383.      FILL
  384.  
  385. Function:
  386.      Fills the current marked area with the current fillstring.
  387.  
  388. Example:
  389.              /* If there is a block already marked, */
  390.              /* then neutralize it. */
  391.           
  392.           GETATTR PROJECT MARK
  393.           if result=TRUE then SETBLOCKMARK
  394.           
  395.              /* Set fillstring to `Fill fillaround!' */
  396.           
  397.           SETATTR PROJECT FILLSTRING FROMVAR '"Fill fillaround!"'
  398.           
  399.              /* Set cursor to the fill-area's beginning */
  400.           GOTOBYTE 10
  401.           
  402.              /* Set block mark */
  403.           SETBLOCKMARK
  404.           
  405.              /* Move cursor */
  406.           GOTOBYTE 100
  407.           
  408.              /* Fill the area */
  409.           FILL
  410.           
  411.              /* Neutralize block marking */
  412.           SETBLOCKMARK
  413.  
  414. See also:
  415.      Menu: `Edit/Fill', SETBLOCKMARK, SETATTR
  416.  
  417. FIND
  418. ====
  419.  
  420. Synopsis:
  421.      FIND PROMPT/S,HEX/S,BACKWARDS/S,QUIET/S,TEXT/F
  422.  
  423. Function:
  424.      Searches a string or a hex string within the current file. By
  425.      success, the cursor is being positioned at the string's beginning.
  426.      The search begins at the current cursor position.
  427.  
  428. Arguments:
  429.     PROMPT/S:
  430.           Opens the searchrequester. BACKWARDS and QUIET will be
  431.           ignored.
  432.  
  433.     HEX/S:
  434.           The string to be searched was recognized as a hex string.
  435.  
  436.     BACKWARDS/S:
  437.           Searches backwards.
  438.  
  439.     QUIET/S:
  440.           No requester will be opened by failure.
  441.  
  442.     TEXT/F:
  443.           The string or hex string.
  444.  
  445. Returncodes:
  446.      Return code = 5, if the string could not to be found.
  447.  
  448. Example:
  449.              /* Search the string `$VER:' without opening */
  450.              /* a requester by failure */
  451.           FIND QUIET TEXT '$VER:'
  452.  
  453. See also:
  454.      Attributs: `PROJECT/#?SEARCH', FINDNEXT, FINDCHANGE, Menu:
  455.      `Search&Replace/#?'
  456.  
  457. FINDCHANGE
  458. ==========
  459.  
  460. Synopsis:
  461.      FINDCHANGE PROMPT/S,HEX/S,ALL/S,BACKWARDS/S,QUIET/S,FIND,CHANGE
  462.  
  463. Function:
  464.      Searches a string or a hexstring within a file and replaces it
  465.      throgh a new one. Maybe a requester appears to verify the
  466.      replacement.  The search will start from the current
  467.      cursorposition.
  468.  
  469. Arguments:
  470.     PROMPT/S:
  471.           Opens a `search and replace'-requester.  ALL,BACKWARDS und
  472.           QUIET will be ignored.
  473.  
  474.     HEX/S:
  475.           The text to search for is a hexstring.
  476.  
  477.     ALL/S:
  478.           All found positions will be replaced without requester each
  479.           time.
  480.  
  481.     BACKWARDS/S:
  482.           Search backwards.
  483.  
  484.     QUIET/S:
  485.           No requester will be opened by failure.
  486.  
  487.     FIND:
  488.           The string or hexstring.
  489.  
  490.     CHANGE:
  491.           The replacestring or -hexstring.
  492.  
  493. Returncodes:
  494.      rc = 5, if the string could not be found.
  495.  
  496. Example:
  497.              /* Replaces all `Claas' through `Klaas' */
  498.           FINDCHANGE QUIET ALL 'Claas' 'Klaas'
  499.           FINDCHANGE BACKWARDS QUIET ALL 'Claas' 'Klaas'
  500.  
  501. See also:
  502.      FINDNEXT, FIND, Menu: `Search&Replace/#?'
  503.  
  504. FINDNEXT
  505. ========
  506.  
  507. Synopsis:
  508.      FINDNEXT BACKWARDS/S,QUIET/S
  509.  
  510. Function:
  511.      Continues the last search option, i.e. either search or
  512.      search&replace.
  513.  
  514. Arguments:
  515.     BACKWARDS/S:
  516.           Continue search backwards.
  517.  
  518.     QUIET/S:
  519.           No requester.
  520.  
  521. Returncodes:
  522.      rc = 5, if search fails.
  523.  
  524. See also:
  525.      FIND, FINDCHANGE
  526.  
  527. FONT
  528. ====
  529.  
  530. Synopsis:
  531.      FONT NAME/A,SIZE/N/A
  532.  
  533. Function:
  534.      Sets an specified Font.
  535.  
  536. Arguments:
  537.     NAME/A:
  538.           The font name.
  539.  
  540.     SIZE/N/A.
  541.           The font size.
  542.  
  543. Example:
  544.      FONT 'horror.font' 8
  545.  
  546. GETATTR
  547. =======
  548.  
  549. Synopsis:
  550.      GETATTR OBJECT/A,FIELD,STEM/K,VAR/K
  551.  
  552. Function:
  553.      Finds out the value of one ore more variables used in the program.
  554.  
  555. Arguments:
  556.     OBJECT/A:
  557.           Name of the object.
  558.  
  559.     FIELD:
  560.           Name of the field.
  561.  
  562.      If FIELD is not defined, a STEM variable must be specified. There
  563.      will all the object's value be stored.
  564.  
  565. Example:
  566.           GETATTR WINDOW TITLE
  567.           
  568.              /* Result contains now the titel of the window */
  569.              /* e.g.:`File: ENV:Sys/overscan.prefs (70 Bytes)'*/
  570.  
  571. See also:
  572.      Attributes, SETATTR
  573.  
  574. GETBLOCK
  575. ========
  576.  
  577. Synopsis:
  578.      GETBLOCK        VAR/K,STEM/K => BLOCK
  579.  
  580. Function:
  581.      Establishes the content of the blockbuffer.
  582.  
  583. Returncodes:
  584.     BLOCK:
  585.           Contents a block as hexstring.
  586.  
  587. See also:
  588.      SETBLOCK
  589.  
  590. GETBYTES
  591. ========
  592.  
  593. Synopsis:
  594.      GETBYTES VAR/K,STEM/K,POS/N/A,NUMBER/N/A => HEXSTRING
  595.  
  596. Function:
  597.      Finds out the value of a number of bytes at one position within a
  598.      file.
  599.  
  600. Arguments:
  601.     POS/N/A:
  602.           Position of the bytes to be found out.
  603.  
  604.     NUMBER/N/A:
  605.           Number of Bytes (max:32767).
  606.  
  607. Returncodes:
  608.     HEXSTRING:
  609.           Hexstring of the bytes.
  610.  
  611. See also:
  612.      SETBYTES
  613.  
  614. GOTOBOOKMARK
  615. ============
  616.  
  617. Synopsis:
  618.      GOTOBOOKMARK NUMBER/N/A
  619.  
  620. Function:
  621.      Sets the cursor to a position previously marked with SETBOOKMARK.
  622.  
  623. Arguments:
  624.     NUMBER/N/A:
  625.           A number between 0 and 10.
  626.  
  627. See also:
  628.      SETBOOKMARK
  629.  
  630. GOTOBYTE
  631. ========
  632.  
  633. Synopsis:
  634.      GOTOBYTE POS/N/A
  635.  
  636. Function:
  637.      Sets the cursor to a specified posizion.
  638.  
  639. Arguments:
  640.     POS/N/A:
  641.           Position.
  642.  
  643. See also:
  644.      COLUMN, GOTOCOLUMN, GOTOLINE, LINE
  645.  
  646. GOTOCOLUMN
  647. ==========
  648.  
  649. Synopsis:
  650.      GOTOCOLUMN COLUMN/N/A
  651.  
  652. Function:
  653.      Sets the cursor to a specified column.
  654.  
  655. Arguments:
  656.     COLUMN/N/A:
  657.           Column between 1 and 16.
  658.  
  659. See also:
  660.      COLUMN, GOTOBYTE, GOTOLINE, LINE
  661.  
  662. GOTOLINE
  663. ========
  664.  
  665. Synopsis:
  666.      GOTOLINE LINE/N/A
  667.  
  668. Function:
  669.      Sets the cursor to a specified line.
  670.  
  671. Arguments:
  672.     LINE/N/A:
  673.           Number of the line.
  674.  
  675. See also:
  676.      COLUMN, GOTOBYTE, GOTOCOLUMN, LINE
  677.  
  678. GRABMEMORY
  679. ==========
  680.  
  681. Synopsis:
  682.      GRABMEMORY START/N/A,END/N/A,FORCE/S
  683.  
  684. Function:
  685.      Displays a part of the memory instead of a file.
  686.  
  687. Arguments:
  688.     START/N/A:
  689.           Memory start address.
  690.  
  691.     END/N/A:
  692.           Memory end adress.
  693.  
  694.     FORCE/S:
  695.           The requester `You made x changes' will be suppressed.
  696.  
  697. Returncodes:
  698.      rc = 5, if the command fails. (requester cancelled).
  699.  
  700. Example:
  701.      GRABMEMORY 200000 280000 FORCE
  702.  
  703. See also:
  704.      Menu: `Project/Grab memory'
  705.  
  706. HELP
  707. ====
  708.  
  709. Synopsis:
  710.      HELP VAR/K,STEM/K,COMMAND => COMMANDDESC,COMMANDLIST/M
  711.  
  712. Function:
  713.      Finds out either an overview of all specified arexxcommands or the
  714.      construction of an command.
  715.  
  716. Arguments:
  717.     COMMAND:
  718.           Commands name, whose construction shall be found out.
  719.  
  720.      If COMMAND is not specified, a command overview will be shown.
  721.  
  722. Returncodes:
  723.      If COMMAND specified:
  724.     COMMANDDESC:
  725.           Command's name.  Otherwise:
  726.     COMMANDLIST/M:
  727.           Command's number and an overview of all commands.
  728.  
  729. INSERT
  730. ======
  731.  
  732. Synopsis:
  733.      INSERT
  734.  
  735. Function:
  736.      Inserts a block from the blockbuffer at the current cursor
  737.      position into the file.
  738.  
  739. See also:
  740.      Menu: `Edit/Insert', SETBLOCKMARK
  741.  
  742. LINE
  743. ====
  744.  
  745. Synopsis:
  746.      LINE DELTA/N/A
  747.  
  748. Function:
  749.      Moves the cursor a defined number of lines.
  750.  
  751. Arguments:
  752.     LINE/N/A:
  753.           Number of lines. Positive values move the cursor downwards.
  754.  
  755. See also:
  756.      COLUMN, GOTOBYTE, GOTOCOLUMN, GOTOLINE
  757.  
  758. LOADBLOCK
  759. =========
  760.  
  761. Synopsis:
  762.      LOADBLOCK NAME
  763.  
  764. Function:
  765.      Loads a block into the blockbuffer.
  766.  
  767. Arguments:
  768.     NAME:
  769.           Filename. If not specified, a requester will be opened.
  770.  
  771. Returncodes:
  772.      rc = 5, if loading failed.
  773.  
  774. See also:
  775.      SAVEBLOCK
  776.  
  777. LOADBLOCKCLIP
  778. =============
  779.  
  780. Synopsis:
  781.      LOADBLOCKCLIP
  782.  
  783. Function:
  784.      Kopiert den aktuellen Inhalt des Clipboards in den Blockspeicher.
  785.  
  786. LOADCOMMANDS
  787. ============
  788.  
  789. Synopsis:
  790.      LOADCOMMANDS NAME
  791.  
  792. Function:
  793.      Loads arexxcommands.
  794.  
  795. Arguments:
  796.     NAME:
  797.           Filename of the commands. If not specified, a requester will
  798.           be opened
  799.  
  800. Returncodes:
  801.      rc = 5, if loading failed.
  802.  
  803. See also:
  804.      Menu: `ARexx/Load commands', SAVECOMMANDS, SAVECOMMANDSAS
  805.  
  806. LOADDISPLAYTYP
  807. ==============
  808.  
  809. Synopsis:
  810.      LOADDISPLAYTYP NAME
  811.  
  812. Function:
  813.      Loads a defined displaytype.
  814.  
  815. Arguments:
  816.     NAME:
  817.           Filename of the displaytype. If not specified, a requester
  818.           will be opened.
  819.  
  820. Returncodes:
  821.      rc = 5, if loading failed.
  822.  
  823. See also:
  824.      Menu: `Settings/Display/#?'
  825.  
  826. LOADSETTINGS
  827. ============
  828.  
  829. Synopsis:
  830.      LOADSETTINGS    NAME
  831.  
  832. Function:
  833.      Loads a settingsfile.
  834.  
  835. Arguments:
  836.     NAME:
  837.           Filename of the settings file. If not specified, a requester
  838.           will be opened.
  839.  
  840. Returncodes:
  841.      rc = 5, if loading failed.
  842.  
  843. See also:
  844.      Menu: `Settings/Load Settings...'
  845.  
  846. MOVEWINDOW
  847. ==========
  848.  
  849. Synopsis:
  850.      MOVEWINDOW LEFTEDGE/N,TOPEDGE/N
  851.  
  852. Function:
  853.      Modifies the FileX window position.
  854.  
  855. Arguments:
  856.     LEFTEDGE/N:
  857.           Space to the left border.
  858.  
  859.     TOPEDGE/N:
  860.           New space to the upper border.
  861.  
  862.      If not specified, the value will remian unchanged.
  863.  
  864. See also:
  865.      CHANGEWINDOW, SIZEWINDOW, ZIPWINDOW, Attributes: `WINDOW/#?'
  866.  
  867. NOP
  868. ===
  869.  
  870. Synopsis:
  871.      NOP
  872.  
  873. Function:
  874.      This command has no, indeed no effect. :-) Very useful for nothing.
  875.  
  876. OPEN
  877. ====
  878.  
  879. Synopsis:
  880.      OPEN FILENAME,FORCE/S
  881.  
  882. Function:
  883.      Opens a file.
  884.  
  885. Arguments:
  886.     FILENAME:
  887.           Filename. If not specified, a requester is being opened as
  888.           usual.
  889.  
  890.     FORCE/S:
  891.           The requester `You made x changes' will be suppressed.
  892.  
  893. Returncodes:
  894.      rc = 5, if loading failed.
  895.  
  896. See also:
  897.      CLEAR, SAVE, SAVEAS
  898.  
  899. PASTE
  900. =====
  901.  
  902. Synopsis:
  903.      PASTE
  904.  
  905. Function:
  906.      Writes a block from the blockbuffer into the file beginning with
  907.      the current cursor position.
  908.  
  909. See also:
  910.      Menu: `Edit/Paste', SETBLOCKMARK
  911.  
  912. POSITION
  913. ========
  914.  
  915. Synopsis:
  916.      POSITION SOF/S,EOF/S,SOL/S,EOL/S
  917.  
  918. Function:
  919.      Moves the cursor to a defined position.
  920.  
  921. Arguments:
  922.     SOF/S:
  923.           Moves the cursor to the start of the file.
  924.  
  925.     EOF/S:
  926.           Moves the cursor to the end of the file.
  927.  
  928.     SOL/S:
  929.           Moves the cursor to the start of a line.
  930.  
  931.     EOL/S:
  932.           Moves the cursor to the end of a line.
  933.  
  934.      SOF and EOF and also SOL und EOL exclude each other.
  935.  
  936. PRINT
  937. =====
  938.  
  939. Synopsis:
  940.      PRINT
  941.  
  942. Function:
  943.      Prints the file.
  944.  
  945. PRINTBLOCK
  946. ==========
  947.  
  948. Synopsis:
  949.      PRINTBLOCK
  950.  
  951. Function:
  952.      Prints the block from blockbuffer.
  953.  
  954. QUIT
  955. ====
  956.  
  957. Synopsis:
  958.      QUIT FORCE/S
  959.  
  960. Function:
  961.      Quits FileX.
  962.  
  963. Arguments:
  964.     FORCE/S:
  965.           The requester `You made x changes' will be suppressed.
  966.  
  967. REDO
  968. ====
  969.  
  970. Synopsis:
  971.      REDO NUMBER/N
  972.  
  973. Function:
  974.      A special number of `Undos' will be cancelled.
  975.  
  976. Arguments:
  977.     NUMBER/N:
  978.           Number of `Undos' to be cancelled. If not specified, only the
  979.           last `Undo' will be cancelled.
  980.  
  981. REQUESTFILE
  982. ===========
  983.  
  984. Synopsis:
  985.      REQUESTFILE VAR/K,STEM/K,TITLE/K,PATH/K,FILE/K,PATTERN/K =>
  986.      FILENAME
  987.  
  988. Function:
  989.      Opens a filerequester and gives back an chosen filename.
  990.  
  991. Arguments:
  992.     TITLE/K:
  993.           Title of the filerequester.
  994.  
  995.     PATH/K:
  996.           Pre-set pathname.
  997.  
  998.     FILE/K:
  999.           Pre-set filename.
  1000.  
  1001.     PATTERN/K:
  1002.           Pattern.
  1003.  
  1004. Returncodes:
  1005.      If rc = 5, the filerequester was cancelled.
  1006.  
  1007.      Otherwise:
  1008.     FILENAME:
  1009.           Chosen filename and its path.
  1010.  
  1011. Example:
  1012.      REQUESTFILE TITLE '"Please choose a script:"' PATTERN '#?.filex'
  1013.  
  1014. REQUESTNOTIFY
  1015. =============
  1016.  
  1017. Synopsis:
  1018.      REQUESTNOTIFY PROMPT
  1019.  
  1020. Function:
  1021.      Opens a simple Messagerequester with an gadget.
  1022.  
  1023. Arguments:
  1024.     PROMPT:
  1025.           Title text.
  1026.  
  1027. REQUESTRESPONSE
  1028. ===============
  1029.  
  1030. Synopsis:
  1031.      REQUESTRESPONSE BUTTONS/K,PROMPT/K
  1032.  
  1033. Function:
  1034.      Opens a requester with several gadget to choose and returns the
  1035.      number of the chosen gadget.
  1036.  
  1037. Arguments:
  1038.     BUTTONS/K:
  1039.           A string which defines the construction of the gadgets (see
  1040.           example).
  1041.  
  1042.     PROMPT/K:
  1043.           Titletext.
  1044.  
  1045. Returncodes:
  1046.      rc contains the number of the chosen gadget. The gadget at the
  1047.      right has got the number 0. Alle others are enumerated from left
  1048.      to right beginning with 1.
  1049.  
  1050. Example:
  1051.              /* Opens requester with 4 gadgets */
  1052.           REQUESTRESPONSE BUTTONS `"Gadget 1|Gadget2|Gadget 3|Gadget0"'
  1053.           
  1054.           say 'You have chosen gadget 'rc'.'
  1055.  
  1056. REQUESTSTRING
  1057. =============
  1058.  
  1059. Synopsis:
  1060.      REQUESTSTRING VAR/K,STEM/K,PROMPT/K,DEFAULT/K => STRING
  1061.  
  1062. Function:
  1063.      Opens a requester to enter a string.
  1064.  
  1065. Arguments:
  1066.     PROMPT/K:
  1067.           Titletext.
  1068.  
  1069.     DEFAULT/K:
  1070.           Pre-set string.
  1071.  
  1072. Returncodes:
  1073.      rc = 5, if the requester was cancelled.
  1074.  
  1075.      Else:
  1076.     STRING
  1077.           Entered string.
  1078.  
  1079. RX
  1080. ==
  1081.  
  1082. Synopsis:
  1083.      RX VAR/K,STEM/K,CONSOLE/S,ASYNC/S,COMMAND/F => RC/N,RESULT
  1084.  
  1085. Function:
  1086.      Starts an arexxscript.
  1087.  
  1088. Arguments:
  1089.     CONSOLE/S:
  1090.           If specified, a Window for in- and output will be opened
  1091.  
  1092.     ASYNC/S:
  1093.           The script shall be executed asynchronous.
  1094.  
  1095.     COMMAND/F:
  1096.           Name of the command.
  1097.  
  1098. Returncodes:
  1099.      If executed synchronous:
  1100.     RC/N,RESULT:
  1101.           Returncodes of the script.
  1102.  
  1103. SAVE
  1104. ====
  1105.  
  1106. Synopsis:
  1107.      SAVE
  1108.  
  1109. Function:
  1110.      Saves a file under its current name. If the file does not have a
  1111.      name, a filerequester will appear.
  1112.  
  1113. Returncodes:
  1114.      rc = 5, if the file could not be saved.
  1115.  
  1116. SAVEAS
  1117. ======
  1118.  
  1119. Synopsis:
  1120.      SAVEAS NAME
  1121.  
  1122. Function:
  1123.      Saves the file under a new name.
  1124.  
  1125. Arguments:
  1126.     NAME:
  1127.           Filename, the file shall be saved with. If not specified, a
  1128.           filerequester will appear.
  1129.  
  1130. Returncodes:
  1131.      rc = 5, if the file could not be saved.
  1132.  
  1133. SAVEBLOCK
  1134. =========
  1135.  
  1136. Synopsis:
  1137.      SAVEBLOCK NAME
  1138.  
  1139. Function:
  1140.      Saves the block from the blockbuffer.
  1141.  
  1142. Arguments:
  1143.     NAME:
  1144.           Name, the block shall be saved with. If not specified, a
  1145.           filerequester will appear.
  1146.  
  1147. Returncodes:
  1148.      rc = 5, if the block could not be saved.
  1149.  
  1150. SAVEBLOCKCLIP
  1151. =============
  1152.  
  1153. Synopsis:
  1154.      SAVEBLOCKCLIP
  1155.  
  1156. Function:
  1157.      Copies the block from blockbuffer into the clipboard.
  1158.  
  1159. See also:
  1160.      LOADBLOCKCLIP
  1161.  
  1162. SAVECOMMANDS
  1163. ============
  1164.  
  1165. Synopsis:
  1166.      SAVECOMMANDS
  1167.  
  1168. Function:
  1169.      Saved the installed arexxcommands under the current name.
  1170.  
  1171. Returncodes:
  1172.      rc = 5, if the commands could not be saved.
  1173.  
  1174. SAVECOMMANDSAS
  1175. ==============
  1176.  
  1177. Synopsis:
  1178.      SAVECOMMANDSAS NAME
  1179.  
  1180. Function:
  1181.      Saves the installed arexxcommands under a new name.
  1182.  
  1183. Arguments:
  1184.     NAME:
  1185.           Filename of the commands. If not specified, a filerequester
  1186.           will appear.
  1187.  
  1188. Returncodes:
  1189.      rc = 5, if the commands could not be saved.
  1190.  
  1191. SAVESETTINGS
  1192. ============
  1193.  
  1194. Synopsis:
  1195.      SAVESETTINGS
  1196.  
  1197. Function:
  1198.      Saves the current settingsfile under the current name.
  1199.  
  1200. Returncodes:
  1201.      rc = 5, if the settings could not be saved.
  1202.  
  1203. SAVESETTINGSAS
  1204. ==============
  1205.  
  1206. Synopsis:
  1207.      SAVESETTINGSAS NAME
  1208.  
  1209. Function:
  1210.      Saves the current settings under a new name.
  1211.  
  1212. Arguments:
  1213.     NAME:
  1214.           Filename of the settingsfile. If not specified, a
  1215.           filerequester will be opened.
  1216.  
  1217. Returncodes:
  1218.      rc = 5, if the settings could not be saved.
  1219.  
  1220. SETATTR
  1221. =======
  1222.  
  1223. Synopsis:
  1224.      SETATTR OBJECT/A,FIELD,FROMSTEM/K,FROMVAR/K
  1225.  
  1226. Function:
  1227.      Sets the value of one or more variables used in the program.
  1228.  
  1229. Arguments:
  1230.     OBJECT/A:
  1231.           Object's name.
  1232.  
  1233.     FIELD:
  1234.           Field's name.
  1235.  
  1236.     FROMSTEM/K:
  1237.           Name of a STEM-variable which holds the value to set.
  1238.  
  1239.     FROMVAR/K:
  1240.           Name of a variable which holds a value to set.
  1241.  
  1242.      If FIELD is not specified, a FROMSTEM-variable must be specified.
  1243.      In this variable, several values of the object can be stored.
  1244.  
  1245. Example:
  1246.           mystemvariable.STRINGFILL = TRUE
  1247.           mystemvariable.FILLSTRING = 'Klaas is stupid.'
  1248.           mystemvariable.HEXFILLSTRING = '08 15'
  1249.           
  1250.           SETATTR PROJECT FROMSTEM meinestemvariable
  1251.  
  1252. See also:
  1253.      Attributes, GETATTR
  1254.  
  1255. SETBLOCK
  1256. ========
  1257.  
  1258. Synopsis:
  1259.      SETBLOCK BLOCK/A
  1260.  
  1261. Function:
  1262.      Sets the current block into the blockbuffer.
  1263.  
  1264. Arguments:
  1265.     BLOCK/A:
  1266.           Hexstring.
  1267.  
  1268. Example:
  1269.      SETBLOCK '"0071 12feee de"'
  1270.  
  1271. SETBLOCKMARK
  1272. ============
  1273.  
  1274. Synopsis:
  1275.      SETBLOCKMARK
  1276.  
  1277. Function:
  1278.      Switches between block mark mode and normal mode.
  1279.  
  1280. See also:
  1281.      Menu: `Edit/Mark', Attributs: `PROJECT/MARK', COPY, CUT, FILL
  1282.  
  1283. SETBOOKMARK
  1284. ===========
  1285.  
  1286. Synopsis:
  1287.      SETBOOKMARK NUMBER/N
  1288.  
  1289. Function:
  1290.      Sets a mark at the current cursorposition. By using GOTOBOOKMARK,
  1291.      this mark can be jumped at.
  1292.  
  1293. Arguments:
  1294.     NUMBER/N:
  1295.           Number between 1 and 10, which defines the mark's number.
  1296.  
  1297. See also:
  1298.      GOTOBOOKMARK
  1299.  
  1300. SETBYTES
  1301. ========
  1302.  
  1303. Synopsis:
  1304.      SETBYTES POS/N/A,HEXSTRING/A
  1305.  
  1306. Function:
  1307.      Sets a defined number of bytes at a specified position.
  1308.  
  1309. Arguments:
  1310.     POS/N/A:
  1311.           Position, the bytes shall be set to.
  1312.  
  1313.     HEXSTRING/A:
  1314.           A hexstring of bytes.
  1315.  
  1316. Example:
  1317.           SETBYTES        200 '"4b6c 6161 73"'
  1318.  
  1319. See also:
  1320.      GETBYTES
  1321.  
  1322. SETSCREEN
  1323. =========
  1324.  
  1325. Synopsis:
  1326.      SETSCREEN NAME/K,OWN/S
  1327.  
  1328. Function:
  1329.      Definition of the screen FileX shall be opened on.  Arguments:
  1330.     NAME/K:
  1331.           Name of an publicscreen.
  1332.  
  1333.     OWN/S:
  1334.           An own screen shall be opened. A requester makes it possible
  1335.           to define width, height etc.
  1336.  
  1337. SIZEWINDOW
  1338. ==========
  1339.  
  1340. Synopsis:
  1341.      SIZEWINDOW HEIGHT/N,WIDTH/N
  1342.  
  1343. Function:
  1344.      The FileX window height and width may be modified.
  1345.  
  1346. Arguments:
  1347.     HEIGHT/N:
  1348.           New height.
  1349.  
  1350.     WIDTH/N:
  1351.           New width.
  1352.  
  1353. UNDO
  1354. ====
  1355.  
  1356. Synopsis:
  1357.      UNDO NUMBER/N
  1358.  
  1359. Function:
  1360.      A defined number of changes made to the file will be cancelled.
  1361.  
  1362. Arguments:
  1363.     NUMBER/N:
  1364.           Number of changes which shall be possible to be cancelled.
  1365.           If not specified, only the last change will be cancelled.
  1366.  
  1367. WINDOWTOBACK
  1368. ============
  1369.  
  1370. Synopsis:
  1371.      WINDOWTOBACK
  1372.  
  1373. Function:
  1374.      The window will be moved to the background.
  1375.  
  1376. WINDOWTOFRONT
  1377. =============
  1378.  
  1379. Synopsis:
  1380.      WINDOWTOFRONT
  1381.  
  1382. Function:
  1383.      The window will be moved to the front.
  1384.  
  1385. ZIPWINDOW
  1386. =========
  1387.  
  1388. Synopsis:
  1389.      ZIPWINDOW
  1390.  
  1391. Function:
  1392.      Same function as the zip gadget of the FileX window has got.
  1393.  
  1394. Attributes
  1395. **********
  1396.  
  1397.    Some variables of FileX can be read by the option GETATTR. Probably
  1398. they may also be modified through SETATTR.  Both commands require at
  1399. least the objectname and maybe a fieldname, too.
  1400.  
  1401.    There are three different fieldtypes: Strings, numbers and boolean
  1402. values (`TRUE' or `FALSE').
  1403.  
  1404.    Following are all objects and their belonging fields. For every
  1405. field, its name and the type will be displayed, moreover if it can only
  1406. be read. After that, a content description follows.
  1407.  
  1408. APPLICATION-Object:
  1409. ===================
  1410.  
  1411. "SCREEN", String, read only:
  1412.      Name of the public screen on which FileX has opened its window.
  1413.  
  1414. "VERSION", String, read only:
  1415.      Version number as string.
  1416.  
  1417. "REGNUMBER", Number, read only:
  1418.      Registration number.
  1419.  
  1420. "REGNAME", String, read only:
  1421.      A name to which this version is registered to.
  1422.  
  1423. PROJECT-Object
  1424. ==============
  1425.  
  1426. "AREXX", String, read only:
  1427.      Name ot the arexxport.
  1428.  
  1429. "FILENAME", String:
  1430.      Current filename and its path.
  1431.  
  1432. "PATH", String:
  1433.      Path of the current file.
  1434.  
  1435. "FILE", String:
  1436.      Filename without path.
  1437.  
  1438. "CHANGES", Number, read only:
  1439.      Number of changes in the file.
  1440.  
  1441. "PRIORITY", Number:
  1442.      Task priority of FileX.
  1443.  
  1444. "CURSORPOS", Number, read only:
  1445.      Current cursorposition.
  1446.  
  1447. "MARKPOS", Number, read only:
  1448.      Position of the mark's beginning.
  1449.  
  1450. "FILELEN", Number, read only:
  1451.      Length of the current file.
  1452.  
  1453. "EDITABLE", Bool:
  1454.      TRUE, if the file can be edited.
  1455.  
  1456. "EDITASCII", Bool:
  1457.      TRUE, if the active cursor is in the ascii area.
  1458.  
  1459. "MARK", Bool, read only:
  1460.      TRUE, if a block is being marked at the moment.
  1461.  
  1462. "SEARCHSTRING", String:
  1463.      Search string.
  1464.  
  1465. "REPLACESTRING", String:
  1466.      Replace string.
  1467.  
  1468. "HEXSEARCHSTRING", String:
  1469.      Search hex string.
  1470.  
  1471. "HEXREPLACESTRING", String:
  1472.      Replace hex string.
  1473.  
  1474. "STRINGSEARCH", Bool:
  1475.      TRUE, if last a string was searched.
  1476.  
  1477. "CASESENSETIVSEARCH", Bool:
  1478.      TRUE, if last a case sensitive string was searched.
  1479.  
  1480. "WILDSEARCH", Bool:
  1481.      TRUE, if within the last search a pattern was used.
  1482.  
  1483. "FILLSTRING", String:
  1484.      Fill string.
  1485.  
  1486. "HEXFILLSTRING", String:
  1487.      Fill hex string.
  1488.  
  1489. "STRINGFILL", Bool:
  1490.      TRUE, if last a string was filled.
  1491.  
  1492. "DISPLAYTYP", Number:
  1493.      Current defined display type.
  1494.  
  1495. "MAXUNDOMEMSIZE", Number:
  1496.      Size of the maximum UNDO memory.
  1497.  
  1498. "MAXUNDOLEVEL", Number:
  1499.      Size of the maximum UNDOS.
  1500.  
  1501. "ALTJUMP", Number:
  1502.      Jump width in lines for Alt-CURSORUP/DOWN.
  1503.  
  1504. "SCROLLBORDER", Number:
  1505.      Distance in lines to the upper/lower limit from where on the window
  1506.      shall be scrolled.
  1507.  
  1508. "CLIPBOARDUNIT", Number:
  1509.      Number of the clipboard for the exchange of data from blockbuffer
  1510.      into the clipboard.
  1511.  
  1512. "COMMANDSHELLWINDOW", String:
  1513.      Description of the commandshell window.
  1514.  
  1515. "COMMANDWINDOW", String:
  1516.      Description of th in- and output window for arexxscripts.
  1517.  
  1518. "OVERWRITE", Bool,
  1519.      TRUE, if no requester before saving an already existing file shall
  1520.      appear.
  1521.  
  1522. "USEASL", Bool:
  1523.      TRUE, if `asl.library' and `intuition.library' should be used for
  1524.      the requester. FALSE for `reqtools.library'.  gebraucht.
  1525.  
  1526. "DISPLAY", Number:
  1527.      Defines in which form the file shall be displayed: 1 = only
  1528.      hexddisplay, 2 = only Asciidisplay, 3 = Hex-ASCII mixed display.
  1529.  
  1530. "DISPLAYSPACES", Number:
  1531.      Defines how many Bytes shall be grouped to a block in the
  1532.      hexdisplay: 3 = no blocks, 0 = one byte blocks, 1 = word blocks, 2
  1533.      = long word blocks.
  1534.  
  1535. WINDOW-Object
  1536. =============
  1537.  
  1538. "LEFT", Number, read only:
  1539.      Window offset to the left border.
  1540.  
  1541. "TOP", Number, read only:
  1542.      Window offset to the right border.
  1543.  
  1544. "WIDTH", Number, read only:
  1545.      Width of the window.
  1546.  
  1547. "HEIGHT", Number, read only:
  1548.      Height of the window.
  1549.  
  1550. "TITLE", String, read only:
  1551.      Current windowtitel.
  1552.  
  1553. "MIN_WIDTH", Number, read only:
  1554.      Minimum width of the window.
  1555.  
  1556. "MIN_HEIGHT", Number, read only:
  1557.      Minimum height of the window.
  1558.  
  1559. "MAX_WIDTH", Number, read only:
  1560.      Maximum width of the window.
  1561.  
  1562. "MAX_HEIGHT", Number, read only:
  1563.      Maximum height of the window.
  1564.  
  1565. "SCREEN", String, read only:
  1566.      Name of the public screen on which the window shall be opened on.
  1567.  
  1568.